package org.apache.lucene.analysis.phonetic;
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import java.util.Map;
import org.apache.lucene.analysis.TokenStream;
import org.apache.lucene.analysis.phonetic.DoubleMetaphoneFilter;
import org.apache.lucene.analysis.util.AbstractAnalysisFactory; // javadocs
import org.apache.lucene.analysis.util.TokenFilterFactory;
/**
* Factory for {@link DoubleMetaphoneFilter}.
* <pre class="prettyprint" >
* <fieldType name="text_dblmtphn" class="solr.TextField" positionIncrementGap="100">
* <analyzer>
* <tokenizer class="solr.WhitespaceTokenizerFactory"/>
* <filter class="solr.DoubleMetaphoneFilterFactory" inject="true" maxCodeLength="4"/>
* </analyzer>
* </fieldType></pre>
*
*/
public class DoubleMetaphoneFilterFactory extends TokenFilterFactory
{
/** parameter name: true if encoded tokens should be added as synonyms */
public static final String INJECT = "inject";
/** parameter name: restricts the length of the phonetic code */
public static final String MAX_CODE_LENGTH = "maxCodeLength";
/** default maxCodeLength if not specified */
public static final int DEFAULT_MAX_CODE_LENGTH = 4;
private boolean inject = true;
private int maxCodeLength = DEFAULT_MAX_CODE_LENGTH;
/** Sole constructor. See {@link AbstractAnalysisFactory} for initialization lifecycle. */
public DoubleMetaphoneFilterFactory() {}
@Override
public void init(Map<String, String> args) {
super.init(args);
inject = getBoolean(INJECT, true);
if (args.get(MAX_CODE_LENGTH) != null) {
maxCodeLength = Integer.parseInt(args.get(MAX_CODE_LENGTH));
}
}
@Override
public DoubleMetaphoneFilter create(TokenStream input) {
return new DoubleMetaphoneFilter(input, maxCodeLength, inject);
}
}